<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<title>InternalWorkbook (POI API Documentation)</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
    if (location.href.indexOf('is-external=true') == -1) {
        parent.document.title="InternalWorkbook (POI API Documentation)";
    }
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!--   -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/InternalWorkbook.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/poi/hssf/model/InternalSheet.UnsupportedBOFType.html" title="class in org.apache.poi.hssf.model"><span class="strong">PREV CLASS</span></a></li>
<li><a href="../../../../../org/apache/poi/hssf/model/LineShape.html" title="class in org.apache.poi.hssf.model"><span class="strong">NEXT CLASS</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/poi/hssf/model/InternalWorkbook.html" target="_top">FRAMES</a></li>
<li><a href="InternalWorkbook.html" target="_top">NO FRAMES</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_top");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>SUMMARY:&nbsp;</li>
<li>NESTED&nbsp;|&nbsp;</li>
<li><a href="#field_summary">FIELD</a>&nbsp;|&nbsp;</li>
<li>CONSTR&nbsp;|&nbsp;</li>
<li><a href="#method_summary">METHOD</a></li>
</ul>
<ul class="subNavList">
<li>DETAIL:&nbsp;</li>
<li><a href="#field_detail">FIELD</a>&nbsp;|&nbsp;</li>
<li>CONSTR&nbsp;|&nbsp;</li>
<li><a href="#method_detail">METHOD</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!--   -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<p class="subTitle">org.apache.poi.hssf.model</p>
<h2 title="Class InternalWorkbook" class="title">Class InternalWorkbook</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.poi.hssf.model.InternalWorkbook</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre><a href="../../../../../org/apache/poi/util/Internal.html" title="annotation in org.apache.poi.util">@Internal</a>
public final class <strong>InternalWorkbook</strong>
extends java.lang.Object</pre>
<div class="block">Low level model implementation of a Workbook.  Provides creational methods
 for settings and objects contained in the workbook object.
 <P>
 This file contains the low level binary records starting at the workbook's BOF and
 ending with the workbook's EOF.  Use HSSFWorkbook for a high level representation.
 <P>
 The structures of the highlevel API use references to this to perform most of their
 operations.  Its probably unwise to use these low level structures directly unless you
 really know what you're doing.  I recommend you read the Microsoft Excel 97 Developer's
 Kit (Microsoft Press) and the documentation at http://sc.openoffice.org/excelfileformat.pdf
 before even attempting to use this.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html" title="class in org.apache.poi.hssf.usermodel"><code>HSSFWorkbook</code></a></dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!--   -->
</a>
<h3>Field Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="../../../../../org/apache/poi/hssf/record/SSTRecord.html" title="class in org.apache.poi.hssf.record">SSTRecord</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/model/InternalWorkbook.html#sst">sst</a></strong></code>
<div class="block">this contains a reference to the SSTRecord so that new stings can be added
 to it.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!--   -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/model/InternalWorkbook.html#addBSERecord(org.apache.poi.ddf.EscherBSERecord)">addBSERecord</a></strong>(<a href="../../../../../org/apache/poi/ddf/EscherBSERecord.html" title="class in org.apache.poi.ddf">EscherBSERecord</a>&nbsp;e)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/hssf/record/NameRecord.html" title="class in org.apache.poi.hssf.record">NameRecord</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/model/InternalWorkbook.html#addName(org.apache.poi.hssf.record.NameRecord)">addName</a></strong>(<a href="../../../../../org/apache/poi/hssf/record/NameRecord.html" title="class in org.apache.poi.hssf.record">NameRecord</a>&nbsp;name)</code>
<div class="block">creates new name</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/model/InternalWorkbook.html#addSSTString(org.apache.poi.hssf.record.common.UnicodeString)">addSSTString</a></strong>(<a href="../../../../../org/apache/poi/hssf/record/common/UnicodeString.html" title="class in org.apache.poi.hssf.record.common">UnicodeString</a>&nbsp;string)</code>
<div class="block">Adds a string to the SST table and returns its index (if its a duplicate
 just returns its index and update the counts) ASSUMES compressed unicode
 (meaning 8bit)</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/model/InternalWorkbook.html#changeExternalReference(java.lang.String, java.lang.String)">changeExternalReference</a></strong>(java.lang.String&nbsp;oldUrl,
                       java.lang.String&nbsp;newUrl)</code>
<div class="block">Changes an external referenced file to another file.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>short</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/model/InternalWorkbook.html#checkExternSheet(int)">checkExternSheet</a></strong>(int&nbsp;sheetNumber)</code>
<div class="block">Returns the extern sheet number for specific sheet number.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>short</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/model/InternalWorkbook.html#checkExternSheet(int, int)">checkExternSheet</a></strong>(int&nbsp;firstSheetNumber,
                int&nbsp;lastSheetNumber)</code>
<div class="block">Returns the extern sheet number for specific range of sheets.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/model/InternalWorkbook.html#cloneDrawings(org.apache.poi.hssf.model.InternalSheet)">cloneDrawings</a></strong>(<a href="../../../../../org/apache/poi/hssf/model/InternalSheet.html" title="class in org.apache.poi.hssf.model">InternalSheet</a>&nbsp;sheet)</code>
<div class="block">Check if the cloned sheet has drawings.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/hssf/record/NameRecord.html" title="class in org.apache.poi.hssf.record">NameRecord</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/model/InternalWorkbook.html#cloneFilter(int, int)">cloneFilter</a></strong>(int&nbsp;filterDbNameIndex,
           int&nbsp;newSheetIndex)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/hssf/record/NameRecord.html" title="class in org.apache.poi.hssf.record">NameRecord</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/model/InternalWorkbook.html#createBuiltInName(byte, int)">createBuiltInName</a></strong>(byte&nbsp;builtInName,
                 int&nbsp;sheetNumber)</code>
<div class="block">Generates a NameRecord to represent a built-in region</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/hssf/record/ExtendedFormatRecord.html" title="class in org.apache.poi.hssf.record">ExtendedFormatRecord</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/model/InternalWorkbook.html#createCellXF()">createCellXF</a></strong>()</code>
<div class="block">creates a new Cell-type Extended Format Record and adds it to the end of
  ExtendedFormatRecords collection</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/model/InternalWorkbook.html#createDrawingGroup()">createDrawingGroup</a></strong>()</code>
<div class="block">Creates a primary drawing group record.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/model/InternalWorkbook.html#createFormat(java.lang.String)">createFormat</a></strong>(java.lang.String&nbsp;formatString)</code>
<div class="block">Creates a FormatRecord, inserts it, and returns the index code.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/hssf/record/NameRecord.html" title="class in org.apache.poi.hssf.record">NameRecord</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/model/InternalWorkbook.html#createName()">createName</a></strong>()</code>
<div class="block">creates new name</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/hssf/record/FontRecord.html" title="class in org.apache.poi.hssf.record">FontRecord</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/model/InternalWorkbook.html#createNewFont()">createNewFont</a></strong>()</code>
<div class="block">creates a new font record and adds it to the "font table".</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/hssf/record/StyleRecord.html" title="class in org.apache.poi.hssf.record">StyleRecord</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/model/InternalWorkbook.html#createStyleRecord(int)">createStyleRecord</a></strong>(int&nbsp;xfIndex)</code>
<div class="block">Creates a new StyleRecord, for the given Extended
  Format index, and adds it onto the end of the
  records collection</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../org/apache/poi/hssf/model/InternalWorkbook.html" title="class in org.apache.poi.hssf.model">InternalWorkbook</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/model/InternalWorkbook.html#createWorkbook()">createWorkbook</a></strong>()</code>
<div class="block">Creates an empty workbook object with three blank sheets and all the empty
 fields.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../../org/apache/poi/hssf/model/InternalWorkbook.html" title="class in org.apache.poi.hssf.model">InternalWorkbook</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/model/InternalWorkbook.html#createWorkbook(java.util.List)">createWorkbook</a></strong>(java.util.List&lt;<a href="../../../../../org/apache/poi/hssf/record/Record.html" title="class in org.apache.poi.hssf.record">Record</a>&gt;&nbsp;recs)</code>
<div class="block">read support  for low level
 API.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/model/InternalWorkbook.html#doesContainsSheetName(java.lang.String, int)">doesContainsSheetName</a></strong>(java.lang.String&nbsp;name,
                     int&nbsp;excludeSheetIdx)</code>
<div class="block">Determines whether a workbook contains the provided sheet name.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/hssf/model/DrawingManager2.html" title="class in org.apache.poi.hssf.model">DrawingManager2</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/model/InternalWorkbook.html#findDrawingGroup()">findDrawingGroup</a></strong>()</code>
<div class="block">Finds the primary drawing group, if one already exists</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/hssf/record/Record.html" title="class in org.apache.poi.hssf.record">Record</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/model/InternalWorkbook.html#findFirstRecordBySid(short)">findFirstRecordBySid</a></strong>(short&nbsp;sid)</code>
<div class="block">Returns the first occurance of a record matching a particular sid.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/model/InternalWorkbook.html#findFirstRecordLocBySid(short)">findFirstRecordLocBySid</a></strong>(short&nbsp;sid)</code>
<div class="block">Returns the index of a record matching a particular sid.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/hssf/record/Record.html" title="class in org.apache.poi.hssf.record">Record</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/model/InternalWorkbook.html#findNextRecordBySid(short, int)">findNextRecordBySid</a></strong>(short&nbsp;sid,
                   int&nbsp;pos)</code>
<div class="block">Returns the next occurance of a record matching a particular sid.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/model/InternalWorkbook.html#findSheetFirstNameFromExternSheet(int)">findSheetFirstNameFromExternSheet</a></strong>(int&nbsp;externSheetIndex)</code>
<div class="block">Finds the first sheet name by his extern sheet index</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/model/InternalWorkbook.html#findSheetLastNameFromExternSheet(int)">findSheetLastNameFromExternSheet</a></strong>(int&nbsp;externSheetIndex)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/hssf/record/BackupRecord.html" title="class in org.apache.poi.hssf.record">BackupRecord</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/model/InternalWorkbook.html#getBackupRecord()">getBackupRecord</a></strong>()</code>
<div class="block">Returns the position of the backup record.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/ddf/EscherBSERecord.html" title="class in org.apache.poi.ddf">EscherBSERecord</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/model/InternalWorkbook.html#getBSERecord(int)">getBSERecord</a></strong>(int&nbsp;pictureIndex)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/hssf/record/PaletteRecord.html" title="class in org.apache.poi.hssf.record">PaletteRecord</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/model/InternalWorkbook.html#getCustomPalette()">getCustomPalette</a></strong>()</code>
<div class="block">Returns the custom palette in use for this workbook; if a custom palette record
 does not exist, then it is created.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/hssf/model/DrawingManager2.html" title="class in org.apache.poi.hssf.model">DrawingManager2</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/model/InternalWorkbook.html#getDrawingManager()">getDrawingManager</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/hssf/record/ExtendedFormatRecord.html" title="class in org.apache.poi.hssf.record">ExtendedFormatRecord</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/model/InternalWorkbook.html#getExFormatAt(int)">getExFormatAt</a></strong>(int&nbsp;index)</code>
<div class="block">gets the ExtendedFormatRecord at the given 0-based index</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/ss/formula/EvaluationWorkbook.ExternalName.html" title="class in org.apache.poi.ss.formula">EvaluationWorkbook.ExternalName</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/model/InternalWorkbook.html#getExternalName(int, int)">getExternalName</a></strong>(int&nbsp;externSheetIndex,
               int&nbsp;externNameIndex)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/ss/formula/EvaluationWorkbook.ExternalSheet.html" title="class in org.apache.poi.ss.formula">EvaluationWorkbook.ExternalSheet</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/model/InternalWorkbook.html#getExternalSheet(int)">getExternalSheet</a></strong>(int&nbsp;externSheetIndex)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/model/InternalWorkbook.html#getExternalSheetIndex(java.lang.String, java.lang.String)">getExternalSheetIndex</a></strong>(java.lang.String&nbsp;workbookName,
                     java.lang.String&nbsp;sheetName)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/model/InternalWorkbook.html#getExternalSheetIndex(java.lang.String, java.lang.String, java.lang.String)">getExternalSheetIndex</a></strong>(java.lang.String&nbsp;workbookName,
                     java.lang.String&nbsp;firstSheetName,
                     java.lang.String&nbsp;lastSheetName)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/hssf/record/FileSharingRecord.html" title="class in org.apache.poi.hssf.record">FileSharingRecord</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/model/InternalWorkbook.html#getFileSharing()">getFileSharing</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/model/InternalWorkbook.html#getFirstSheetIndexFromExternSheetIndex(int)">getFirstSheetIndexFromExternSheetIndex</a></strong>(int&nbsp;externSheetNumber)</code>
<div class="block">Finds the (first) sheet index for a particular external sheet number.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/model/InternalWorkbook.html#getFontIndex(org.apache.poi.hssf.record.FontRecord)">getFontIndex</a></strong>(<a href="../../../../../org/apache/poi/hssf/record/FontRecord.html" title="class in org.apache.poi.hssf.record">FontRecord</a>&nbsp;font)</code>
<div class="block">Retrieves the index of the given font</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/hssf/record/FontRecord.html" title="class in org.apache.poi.hssf.record">FontRecord</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/model/InternalWorkbook.html#getFontRecordAt(int)">getFontRecordAt</a></strong>(int&nbsp;idx)</code>
<div class="block">gets the font record at the given index in the font table.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>short</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/model/InternalWorkbook.html#getFormat(java.lang.String, boolean)">getFormat</a></strong>(java.lang.String&nbsp;format,
         boolean&nbsp;createIfNotFound)</code>
<div class="block">Returns a format index that matches the passed in format.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.util.List&lt;<a href="../../../../../org/apache/poi/hssf/record/FormatRecord.html" title="class in org.apache.poi.hssf.record">FormatRecord</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/model/InternalWorkbook.html#getFormats()">getFormats</a></strong>()</code>
<div class="block">Returns the list of FormatRecords in the workbook.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.util.List&lt;<a href="../../../../../org/apache/poi/hssf/record/HyperlinkRecord.html" title="class in org.apache.poi.hssf.record">HyperlinkRecord</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/model/InternalWorkbook.html#getHyperlinks()">getHyperlinks</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/model/InternalWorkbook.html#getLastSheetIndexFromExternSheetIndex(int)">getLastSheetIndexFromExternSheetIndex</a></strong>(int&nbsp;externSheetNumber)</code>
<div class="block">Finds the last sheet index for a particular external sheet number,
  which may be the same as the first (except for multi-sheet references)</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/hssf/record/NameCommentRecord.html" title="class in org.apache.poi.hssf.record">NameCommentRecord</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/model/InternalWorkbook.html#getNameCommentRecord(org.apache.poi.hssf.record.NameRecord)">getNameCommentRecord</a></strong>(<a href="../../../../../org/apache/poi/hssf/record/NameRecord.html" title="class in org.apache.poi.hssf.record">NameRecord</a>&nbsp;nameRecord)</code>
<div class="block">gets the name comment record</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/hssf/record/NameRecord.html" title="class in org.apache.poi.hssf.record">NameRecord</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/model/InternalWorkbook.html#getNameRecord(int)">getNameRecord</a></strong>(int&nbsp;index)</code>
<div class="block">gets the name record</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/ss/formula/ptg/NameXPtg.html" title="class in org.apache.poi.ss.formula.ptg">NameXPtg</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/model/InternalWorkbook.html#getNameXPtg(java.lang.String, int, org.apache.poi.ss.formula.udf.UDFFinder)">getNameXPtg</a></strong>(java.lang.String&nbsp;name,
           int&nbsp;sheetRefIndex,
           <a href="../../../../../org/apache/poi/ss/formula/udf/UDFFinder.html" title="interface in org.apache.poi.ss.formula.udf">UDFFinder</a>&nbsp;udf)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/ss/formula/ptg/NameXPtg.html" title="class in org.apache.poi.ss.formula.ptg">NameXPtg</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/model/InternalWorkbook.html#getNameXPtg(java.lang.String, org.apache.poi.ss.formula.udf.UDFFinder)">getNameXPtg</a></strong>(java.lang.String&nbsp;name,
           <a href="../../../../../org/apache/poi/ss/formula/udf/UDFFinder.html" title="interface in org.apache.poi.ss.formula.udf">UDFFinder</a>&nbsp;udf)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/model/InternalWorkbook.html#getNumberOfFontRecords()">getNumberOfFontRecords</a></strong>()</code>
<div class="block">gets the number of font records</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/model/InternalWorkbook.html#getNumExFormats()">getNumExFormats</a></strong>()</code>
<div class="block">get the number of ExtendedFormat records contained in this workbook.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/model/InternalWorkbook.html#getNumNames()">getNumNames</a></strong>()</code>
<div class="block">gets the total number of names</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/model/InternalWorkbook.html#getNumRecords()">getNumRecords</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/model/InternalWorkbook.html#getNumSheets()">getNumSheets</a></strong>()</code>
<div class="block">returns the number of boundsheet objects contained in this workbook.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/hssf/record/RecalcIdRecord.html" title="class in org.apache.poi.hssf.record">RecalcIdRecord</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/model/InternalWorkbook.html#getRecalcId()">getRecalcId</a></strong>()</code>
<div class="block">Get or create RecalcIdRecord</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.util.List&lt;<a href="../../../../../org/apache/poi/hssf/record/Record.html" title="class in org.apache.poi.hssf.record">Record</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/model/InternalWorkbook.html#getRecords()">getRecords</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/model/InternalWorkbook.html#getSheetIndex(java.lang.String)">getSheetIndex</a></strong>(java.lang.String&nbsp;name)</code>
<div class="block">get the sheet's index</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/model/InternalWorkbook.html#getSheetName(int)">getSheetName</a></strong>(int&nbsp;sheetIndex)</code>
<div class="block">gets the name for a given sheet.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/model/InternalWorkbook.html#getSize()">getSize</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/hssf/record/NameRecord.html" title="class in org.apache.poi.hssf.record">NameRecord</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/model/InternalWorkbook.html#getSpecificBuiltinRecord(byte, int)">getSpecificBuiltinRecord</a></strong>(byte&nbsp;name,
                        int&nbsp;sheetNumber)</code>
<div class="block">Retrieves the Builtin NameRecord that matches the name and index
 There shouldn't be too many names to make the sequential search too slow</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/hssf/record/common/UnicodeString.html" title="class in org.apache.poi.hssf.record.common">UnicodeString</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/model/InternalWorkbook.html#getSSTString(int)">getSSTString</a></strong>(int&nbsp;str)</code>
<div class="block">given an index into the SST table, this function returns the corresponding String value</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/hssf/record/StyleRecord.html" title="class in org.apache.poi.hssf.record">StyleRecord</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/model/InternalWorkbook.html#getStyleRecord(int)">getStyleRecord</a></strong>(int&nbsp;xfIndex)</code>
<div class="block">Returns the StyleRecord for the given
  xfIndex, or null if that ExtendedFormat doesn't
  have a Style set.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/hssf/record/WindowOneRecord.html" title="class in org.apache.poi.hssf.record">WindowOneRecord</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/model/InternalWorkbook.html#getWindowOne()">getWindowOne</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/hssf/record/WriteAccessRecord.html" title="class in org.apache.poi.hssf.record">WriteAccessRecord</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/model/InternalWorkbook.html#getWriteAccess()">getWriteAccess</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/hssf/record/WriteProtectRecord.html" title="class in org.apache.poi.hssf.record">WriteProtectRecord</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/model/InternalWorkbook.html#getWriteProtect()">getWriteProtect</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/model/InternalWorkbook.html#insertSST()">insertSST</a></strong>()</code>
<div class="block">use this function to add a Shared String Table to an existing sheet (say
 generated by a different java api) without an sst....</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/model/InternalWorkbook.html#isSheetHidden(int)">isSheetHidden</a></strong>(int&nbsp;sheetnum)</code>
<div class="block">Gets the hidden flag for a given sheet.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/model/InternalWorkbook.html#isSheetVeryHidden(int)">isSheetVeryHidden</a></strong>(int&nbsp;sheetnum)</code>
<div class="block">Gets the very hidden flag for a given sheet.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/model/InternalWorkbook.html#isUsing1904DateWindowing()">isUsing1904DateWindowing</a></strong>()</code>
<div class="block">Whether date windowing is based on 1/2/1904 or 1/1/1900.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/model/InternalWorkbook.html#isWriteProtected()">isWriteProtected</a></strong>()</code>
<div class="block">is the workbook protected with a password (not encrypted)?</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/model/InternalWorkbook.html#linkExternalWorkbook(java.lang.String, org.apache.poi.ss.usermodel.Workbook)">linkExternalWorkbook</a></strong>(java.lang.String&nbsp;name,
                    <a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a>&nbsp;externalWorkbook)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/model/InternalWorkbook.html#preSerialize()">preSerialize</a></strong>()</code>
<div class="block">Perform any work necessary before the workbook is about to be serialized.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/model/InternalWorkbook.html#removeBuiltinRecord(byte, int)">removeBuiltinRecord</a></strong>(byte&nbsp;name,
                   int&nbsp;sheetIndex)</code>
<div class="block">Removes the specified Builtin NameRecord that matches the name and index</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/model/InternalWorkbook.html#removeExFormatRecord(org.apache.poi.hssf.record.ExtendedFormatRecord)">removeExFormatRecord</a></strong>(<a href="../../../../../org/apache/poi/hssf/record/ExtendedFormatRecord.html" title="class in org.apache.poi.hssf.record">ExtendedFormatRecord</a>&nbsp;rec)</code>
<div class="block">Removes the given ExtendedFormatRecord record from the
  file's list.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/model/InternalWorkbook.html#removeExFormatRecord(int)">removeExFormatRecord</a></strong>(int&nbsp;index)</code>
<div class="block">Removes ExtendedFormatRecord record with given index from the
  file's list.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/model/InternalWorkbook.html#removeFontRecord(org.apache.poi.hssf.record.FontRecord)">removeFontRecord</a></strong>(<a href="../../../../../org/apache/poi/hssf/record/FontRecord.html" title="class in org.apache.poi.hssf.record">FontRecord</a>&nbsp;rec)</code>
<div class="block">Removes the given font record from the
  file's list.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/model/InternalWorkbook.html#removeName(int)">removeName</a></strong>(int&nbsp;nameIndex)</code>
<div class="block">removes the name</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/model/InternalWorkbook.html#removeSheet(int)">removeSheet</a></strong>(int&nbsp;sheetIndex)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/model/InternalWorkbook.html#resolveNameXText(int, int)">resolveNameXText</a></strong>(int&nbsp;refIndex,
                int&nbsp;definedNameIndex)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/model/InternalWorkbook.html#serialize(int, byte[])">serialize</a></strong>(int&nbsp;offset,
         byte[]&nbsp;data)</code>
<div class="block">Serializes all records int the worksheet section into a big byte array.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/model/InternalWorkbook.html#setSheetBof(int, int)">setSheetBof</a></strong>(int&nbsp;sheetIndex,
           int&nbsp;pos)</code>
<div class="block">Sets the BOF for a given sheet</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/model/InternalWorkbook.html#setSheetHidden(int, boolean)">setSheetHidden</a></strong>(int&nbsp;sheetnum,
              boolean&nbsp;hidden)</code>
<div class="block">Hide or unhide a sheet</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/model/InternalWorkbook.html#setSheetHidden(int, int)">setSheetHidden</a></strong>(int&nbsp;sheetnum,
              int&nbsp;hidden)</code>
<div class="block">Hide or unhide a sheet.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/model/InternalWorkbook.html#setSheetName(int, java.lang.String)">setSheetName</a></strong>(int&nbsp;sheetnum,
            java.lang.String&nbsp;sheetname)</code>
<div class="block">sets the name for a given sheet.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/model/InternalWorkbook.html#setSheetOrder(java.lang.String, int)">setSheetOrder</a></strong>(java.lang.String&nbsp;sheetname,
             int&nbsp;pos)</code>
<div class="block">sets the order of appearance for a given sheet.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/model/InternalWorkbook.html#unwriteProtectWorkbook()">unwriteProtectWorkbook</a></strong>()</code>
<div class="block">removes the write protect flag</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/model/InternalWorkbook.html#updateNameCommentRecordCache(org.apache.poi.hssf.record.NameCommentRecord)">updateNameCommentRecordCache</a></strong>(<a href="../../../../../org/apache/poi/hssf/record/NameCommentRecord.html" title="class in org.apache.poi.hssf.record">NameCommentRecord</a>&nbsp;commentRecord)</code>
<div class="block">If a <a href="../../../../../org/apache/poi/hssf/record/NameCommentRecord.html" title="class in org.apache.poi.hssf.record"><code>NameCommentRecord</code></a> is added or the name it references
  is renamed, then this will update the lookup cache for it.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/model/InternalWorkbook.html#updateNamesAfterCellShift(org.apache.poi.ss.formula.FormulaShifter)">updateNamesAfterCellShift</a></strong>(<a href="../../../../../org/apache/poi/ss/formula/FormulaShifter.html" title="class in org.apache.poi.ss.formula">FormulaShifter</a>&nbsp;shifter)</code>
<div class="block">Updates named ranges due to moving of cells</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/model/InternalWorkbook.html#writeProtectWorkbook(java.lang.String, java.lang.String)">writeProtectWorkbook</a></strong>(java.lang.String&nbsp;password,
                    java.lang.String&nbsp;username)</code>
<div class="block">protect a workbook with a password (not encypted, just sets writeprotect
 flags and the password.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!--   -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!--   -->
</a>
<h3>Field Detail</h3>
<a name="sst">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>sst</h4>
<pre>protected&nbsp;<a href="../../../../../org/apache/poi/hssf/record/SSTRecord.html" title="class in org.apache.poi.hssf.record">SSTRecord</a> sst</pre>
<div class="block">this contains a reference to the SSTRecord so that new stings can be added
 to it.</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!--   -->
</a>
<h3>Method Detail</h3>
<a name="createWorkbook(java.util.List)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createWorkbook</h4>
<pre>public static&nbsp;<a href="../../../../../org/apache/poi/hssf/model/InternalWorkbook.html" title="class in org.apache.poi.hssf.model">InternalWorkbook</a>&nbsp;createWorkbook(java.util.List&lt;<a href="../../../../../org/apache/poi/hssf/record/Record.html" title="class in org.apache.poi.hssf.record">Record</a>&gt;&nbsp;recs)</pre>
<div class="block">read support  for low level
 API.  Pass in an array of Record objects, A Workbook
 object is constructed and passed back with all of its initialization set
 to the passed in records and references to those records held. Unlike Sheet
 workbook does not use an offset (its assumed to be 0) since its first in a file.
 If you need an offset then construct a new array with a 0 offset or write your
 own ;-p.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>recs</code> - an array of Record objects</dd>
<dt><span class="strong">Returns:</span></dt><dd>Workbook object</dd></dl>
</li>
</ul>
<a name="createWorkbook()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createWorkbook</h4>
<pre>public static&nbsp;<a href="../../../../../org/apache/poi/hssf/model/InternalWorkbook.html" title="class in org.apache.poi.hssf.model">InternalWorkbook</a>&nbsp;createWorkbook()</pre>
<div class="block">Creates an empty workbook object with three blank sheets and all the empty
 fields.  Use this to create a workbook from scratch.</div>
</li>
</ul>
<a name="getSpecificBuiltinRecord(byte, int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSpecificBuiltinRecord</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/hssf/record/NameRecord.html" title="class in org.apache.poi.hssf.record">NameRecord</a>&nbsp;getSpecificBuiltinRecord(byte&nbsp;name,
                                  int&nbsp;sheetNumber)</pre>
<div class="block">Retrieves the Builtin NameRecord that matches the name and index
 There shouldn't be too many names to make the sequential search too slow</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - byte representation of the builtin name to match</dd><dd><code>sheetNumber</code> - 1-based sheet number</dd>
<dt><span class="strong">Returns:</span></dt><dd>null if no builtin NameRecord matches</dd></dl>
</li>
</ul>
<a name="removeBuiltinRecord(byte, int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeBuiltinRecord</h4>
<pre>public&nbsp;void&nbsp;removeBuiltinRecord(byte&nbsp;name,
                       int&nbsp;sheetIndex)</pre>
<div class="block">Removes the specified Builtin NameRecord that matches the name and index</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - byte representation of the builtin to match</dd><dd><code>sheetIndex</code> - zero-based sheet reference</dd></dl>
</li>
</ul>
<a name="getNumRecords()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNumRecords</h4>
<pre>public&nbsp;int&nbsp;getNumRecords()</pre>
</li>
</ul>
<a name="getFontRecordAt(int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFontRecordAt</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/hssf/record/FontRecord.html" title="class in org.apache.poi.hssf.record">FontRecord</a>&nbsp;getFontRecordAt(int&nbsp;idx)</pre>
<div class="block">gets the font record at the given index in the font table.  Remember
 "There is No Four" (someone at M$ must have gone to Rocky Horror one too
 many times)</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>idx</code> - the index to look at (0 or greater but NOT 4)</dd>
<dt><span class="strong">Returns:</span></dt><dd>FontRecord located at the given index</dd></dl>
</li>
</ul>
<a name="getFontIndex(org.apache.poi.hssf.record.FontRecord)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFontIndex</h4>
<pre>public&nbsp;int&nbsp;getFontIndex(<a href="../../../../../org/apache/poi/hssf/record/FontRecord.html" title="class in org.apache.poi.hssf.record">FontRecord</a>&nbsp;font)</pre>
<div class="block">Retrieves the index of the given font</div>
</li>
</ul>
<a name="createNewFont()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createNewFont</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/hssf/record/FontRecord.html" title="class in org.apache.poi.hssf.record">FontRecord</a>&nbsp;createNewFont()</pre>
<div class="block">creates a new font record and adds it to the "font table".  This causes the
 boundsheets to move down one, extended formats to move down (so this function moves
 those pointers as well)</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>FontRecord that was just created</dd></dl>
</li>
</ul>
<a name="removeFontRecord(org.apache.poi.hssf.record.FontRecord)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeFontRecord</h4>
<pre>public&nbsp;void&nbsp;removeFontRecord(<a href="../../../../../org/apache/poi/hssf/record/FontRecord.html" title="class in org.apache.poi.hssf.record">FontRecord</a>&nbsp;rec)</pre>
<div class="block">Removes the given font record from the
  file's list. This will make all
  subsequent font indicies drop by one,
  so you'll need to update those yourself!</div>
</li>
</ul>
<a name="getNumberOfFontRecords()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNumberOfFontRecords</h4>
<pre>public&nbsp;int&nbsp;getNumberOfFontRecords()</pre>
<div class="block">gets the number of font records</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>number of font records in the "font table"</dd></dl>
</li>
</ul>
<a name="setSheetBof(int, int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSheetBof</h4>
<pre>public&nbsp;void&nbsp;setSheetBof(int&nbsp;sheetIndex,
               int&nbsp;pos)</pre>
<div class="block">Sets the BOF for a given sheet</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>sheetIndex</code> - the number of the sheet to set the positing of the bof for</dd><dd><code>pos</code> - the actual bof position</dd></dl>
</li>
</ul>
<a name="getBackupRecord()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBackupRecord</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/hssf/record/BackupRecord.html" title="class in org.apache.poi.hssf.record">BackupRecord</a>&nbsp;getBackupRecord()</pre>
<div class="block">Returns the position of the backup record.</div>
</li>
</ul>
<a name="setSheetName(int, java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSheetName</h4>
<pre>public&nbsp;void&nbsp;setSheetName(int&nbsp;sheetnum,
                java.lang.String&nbsp;sheetname)</pre>
<div class="block">sets the name for a given sheet.  If the boundsheet record doesn't exist and
 its only one more than we have, go ahead and create it.  If it's &gt; 1 more than
 we have, except</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>sheetnum</code> - the sheet number (0 based)</dd><dd><code>sheetname</code> - the name for the sheet</dd></dl>
</li>
</ul>
<a name="doesContainsSheetName(java.lang.String, int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>doesContainsSheetName</h4>
<pre>public&nbsp;boolean&nbsp;doesContainsSheetName(java.lang.String&nbsp;name,
                            int&nbsp;excludeSheetIdx)</pre>
<div class="block">Determines whether a workbook contains the provided sheet name.  For the purpose of
 comparison, long names are truncated to 31 chars.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name to test (case insensitive match)</dd><dd><code>excludeSheetIdx</code> - the sheet to exclude from the check or -1 to include all sheets in the check.</dd>
<dt><span class="strong">Returns:</span></dt><dd>true if the sheet contains the name, false otherwise.</dd></dl>
</li>
</ul>
<a name="setSheetOrder(java.lang.String, int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSheetOrder</h4>
<pre>public&nbsp;void&nbsp;setSheetOrder(java.lang.String&nbsp;sheetname,
                 int&nbsp;pos)</pre>
<div class="block">sets the order of appearance for a given sheet.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>sheetname</code> - the name of the sheet to reorder</dd><dd><code>pos</code> - the position that we want to insert the sheet into (0 based)</dd></dl>
</li>
</ul>
<a name="getSheetName(int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSheetName</h4>
<pre>public&nbsp;java.lang.String&nbsp;getSheetName(int&nbsp;sheetIndex)</pre>
<div class="block">gets the name for a given sheet.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>sheetIndex</code> - the sheet number (0 based)</dd>
<dt><span class="strong">Returns:</span></dt><dd>sheetname the name for the sheet</dd></dl>
</li>
</ul>
<a name="isSheetHidden(int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isSheetHidden</h4>
<pre>public&nbsp;boolean&nbsp;isSheetHidden(int&nbsp;sheetnum)</pre>
<div class="block">Gets the hidden flag for a given sheet.
 Note that a sheet could instead be
  set to be very hidden, which is different
  (<a href="../../../../../org/apache/poi/hssf/model/InternalWorkbook.html#isSheetVeryHidden(int)"><code>isSheetVeryHidden(int)</code></a>)</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>sheetnum</code> - the sheet number (0 based)</dd>
<dt><span class="strong">Returns:</span></dt><dd>True if sheet is hidden</dd></dl>
</li>
</ul>
<a name="isSheetVeryHidden(int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isSheetVeryHidden</h4>
<pre>public&nbsp;boolean&nbsp;isSheetVeryHidden(int&nbsp;sheetnum)</pre>
<div class="block">Gets the very hidden flag for a given sheet.
 This is different from the normal
  hidden flag
  (<a href="../../../../../org/apache/poi/hssf/model/InternalWorkbook.html#isSheetHidden(int)"><code>isSheetHidden(int)</code></a>)</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>sheetnum</code> - the sheet number (0 based)</dd>
<dt><span class="strong">Returns:</span></dt><dd>True if sheet is very hidden</dd></dl>
</li>
</ul>
<a name="setSheetHidden(int, boolean)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSheetHidden</h4>
<pre>public&nbsp;void&nbsp;setSheetHidden(int&nbsp;sheetnum,
                  boolean&nbsp;hidden)</pre>
<div class="block">Hide or unhide a sheet</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>sheetnum</code> - The sheet number</dd><dd><code>hidden</code> - True to mark the sheet as hidden, false otherwise</dd></dl>
</li>
</ul>
<a name="setSheetHidden(int, int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSheetHidden</h4>
<pre>public&nbsp;void&nbsp;setSheetHidden(int&nbsp;sheetnum,
                  int&nbsp;hidden)</pre>
<div class="block">Hide or unhide a sheet.
  0 = not hidden
  1 = hidden
  2 = very hidden.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>sheetnum</code> - The sheet number</dd><dd><code>hidden</code> - 0 for not hidden, 1 for hidden, 2 for very hidden</dd></dl>
</li>
</ul>
<a name="getSheetIndex(java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSheetIndex</h4>
<pre>public&nbsp;int&nbsp;getSheetIndex(java.lang.String&nbsp;name)</pre>
<div class="block">get the sheet's index</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - sheet name</dd>
<dt><span class="strong">Returns:</span></dt><dd>sheet index or -1 if it was not found.</dd></dl>
</li>
</ul>
<a name="removeSheet(int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeSheet</h4>
<pre>public&nbsp;void&nbsp;removeSheet(int&nbsp;sheetIndex)</pre>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>sheetIndex</code> - zero based sheet index</dd></dl>
</li>
</ul>
<a name="getNumSheets()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNumSheets</h4>
<pre>public&nbsp;int&nbsp;getNumSheets()</pre>
<div class="block">returns the number of boundsheet objects contained in this workbook.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>number of BoundSheet records</dd></dl>
</li>
</ul>
<a name="getNumExFormats()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNumExFormats</h4>
<pre>public&nbsp;int&nbsp;getNumExFormats()</pre>
<div class="block">get the number of ExtendedFormat records contained in this workbook.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>int count of ExtendedFormat records</dd></dl>
</li>
</ul>
<a name="getExFormatAt(int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExFormatAt</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/hssf/record/ExtendedFormatRecord.html" title="class in org.apache.poi.hssf.record">ExtendedFormatRecord</a>&nbsp;getExFormatAt(int&nbsp;index)</pre>
<div class="block">gets the ExtendedFormatRecord at the given 0-based index</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - of the Extended format record (0-based)</dd>
<dt><span class="strong">Returns:</span></dt><dd>ExtendedFormatRecord at the given index</dd></dl>
</li>
</ul>
<a name="removeExFormatRecord(org.apache.poi.hssf.record.ExtendedFormatRecord)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeExFormatRecord</h4>
<pre>public&nbsp;void&nbsp;removeExFormatRecord(<a href="../../../../../org/apache/poi/hssf/record/ExtendedFormatRecord.html" title="class in org.apache.poi.hssf.record">ExtendedFormatRecord</a>&nbsp;rec)</pre>
<div class="block">Removes the given ExtendedFormatRecord record from the
  file's list. This will make all
  subsequent font indicies drop by one,
  so you'll need to update those yourself!</div>
</li>
</ul>
<a name="removeExFormatRecord(int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeExFormatRecord</h4>
<pre>public&nbsp;void&nbsp;removeExFormatRecord(int&nbsp;index)</pre>
<div class="block">Removes ExtendedFormatRecord record with given index from the
  file's list. This will make all
  subsequent font indicies drop by one,
  so you'll need to update those yourself!</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - of the Extended format record (0-based)</dd></dl>
</li>
</ul>
<a name="createCellXF()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createCellXF</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/hssf/record/ExtendedFormatRecord.html" title="class in org.apache.poi.hssf.record">ExtendedFormatRecord</a>&nbsp;createCellXF()</pre>
<div class="block">creates a new Cell-type Extended Format Record and adds it to the end of
  ExtendedFormatRecords collection</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>ExtendedFormatRecord that was created</dd></dl>
</li>
</ul>
<a name="getStyleRecord(int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStyleRecord</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/hssf/record/StyleRecord.html" title="class in org.apache.poi.hssf.record">StyleRecord</a>&nbsp;getStyleRecord(int&nbsp;xfIndex)</pre>
<div class="block">Returns the StyleRecord for the given
  xfIndex, or null if that ExtendedFormat doesn't
  have a Style set.</div>
</li>
</ul>
<a name="createStyleRecord(int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createStyleRecord</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/hssf/record/StyleRecord.html" title="class in org.apache.poi.hssf.record">StyleRecord</a>&nbsp;createStyleRecord(int&nbsp;xfIndex)</pre>
<div class="block">Creates a new StyleRecord, for the given Extended
  Format index, and adds it onto the end of the
  records collection</div>
</li>
</ul>
<a name="addSSTString(org.apache.poi.hssf.record.common.UnicodeString)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addSSTString</h4>
<pre>public&nbsp;int&nbsp;addSSTString(<a href="../../../../../org/apache/poi/hssf/record/common/UnicodeString.html" title="class in org.apache.poi.hssf.record.common">UnicodeString</a>&nbsp;string)</pre>
<div class="block">Adds a string to the SST table and returns its index (if its a duplicate
 just returns its index and update the counts) ASSUMES compressed unicode
 (meaning 8bit)</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>string</code> - the string to be added to the SSTRecord</dd>
<dt><span class="strong">Returns:</span></dt><dd>index of the string within the SSTRecord</dd></dl>
</li>
</ul>
<a name="getSSTString(int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSSTString</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/hssf/record/common/UnicodeString.html" title="class in org.apache.poi.hssf.record.common">UnicodeString</a>&nbsp;getSSTString(int&nbsp;str)</pre>
<div class="block">given an index into the SST table, this function returns the corresponding String value</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>String containing the SST String</dd></dl>
</li>
</ul>
<a name="insertSST()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>insertSST</h4>
<pre>public&nbsp;void&nbsp;insertSST()</pre>
<div class="block">use this function to add a Shared String Table to an existing sheet (say
 generated by a different java api) without an sst....</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/poi/hssf/model/InternalWorkbook.html#createExtendedSST()"><code>createExtendedSST()</code></a>, 
<a href="../../../../../org/apache/poi/hssf/record/SSTRecord.html" title="class in org.apache.poi.hssf.record"><code>SSTRecord</code></a></dd></dl>
</li>
</ul>
<a name="serialize(int, byte[])">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>serialize</h4>
<pre>public&nbsp;int&nbsp;serialize(int&nbsp;offset,
            byte[]&nbsp;data)</pre>
<div class="block">Serializes all records int the worksheet section into a big byte array. Use
 this to write the Workbook out.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>offset</code> - of the data to be written</dd><dd><code>data</code> - array of bytes to write this to</dd></dl>
</li>
</ul>
<a name="preSerialize()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>preSerialize</h4>
<pre>public&nbsp;void&nbsp;preSerialize()</pre>
<div class="block">Perform any work necessary before the workbook is about to be serialized.

 Include in it ant code that modifies the workbook record stream and affects its size.</div>
</li>
</ul>
<a name="getSize()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSize</h4>
<pre>public&nbsp;int&nbsp;getSize()</pre>
</li>
</ul>
<a name="linkExternalWorkbook(java.lang.String, org.apache.poi.ss.usermodel.Workbook)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>linkExternalWorkbook</h4>
<pre>public&nbsp;int&nbsp;linkExternalWorkbook(java.lang.String&nbsp;name,
                       <a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a>&nbsp;externalWorkbook)</pre>
</li>
</ul>
<a name="findSheetFirstNameFromExternSheet(int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>findSheetFirstNameFromExternSheet</h4>
<pre>public&nbsp;java.lang.String&nbsp;findSheetFirstNameFromExternSheet(int&nbsp;externSheetIndex)</pre>
<div class="block">Finds the first sheet name by his extern sheet index</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>externSheetIndex</code> - extern sheet index</dd>
<dt><span class="strong">Returns:</span></dt><dd>first sheet name.</dd></dl>
</li>
</ul>
<a name="findSheetLastNameFromExternSheet(int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>findSheetLastNameFromExternSheet</h4>
<pre>public&nbsp;java.lang.String&nbsp;findSheetLastNameFromExternSheet(int&nbsp;externSheetIndex)</pre>
</li>
</ul>
<a name="getExternalSheet(int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExternalSheet</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/ss/formula/EvaluationWorkbook.ExternalSheet.html" title="class in org.apache.poi.ss.formula">EvaluationWorkbook.ExternalSheet</a>&nbsp;getExternalSheet(int&nbsp;externSheetIndex)</pre>
</li>
</ul>
<a name="getExternalName(int, int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExternalName</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/ss/formula/EvaluationWorkbook.ExternalName.html" title="class in org.apache.poi.ss.formula">EvaluationWorkbook.ExternalName</a>&nbsp;getExternalName(int&nbsp;externSheetIndex,
                                              int&nbsp;externNameIndex)</pre>
</li>
</ul>
<a name="getFirstSheetIndexFromExternSheetIndex(int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFirstSheetIndexFromExternSheetIndex</h4>
<pre>public&nbsp;int&nbsp;getFirstSheetIndexFromExternSheetIndex(int&nbsp;externSheetNumber)</pre>
<div class="block">Finds the (first) sheet index for a particular external sheet number.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>externSheetNumber</code> - The external sheet number to convert</dd>
<dt><span class="strong">Returns:</span></dt><dd>The index to the sheet found.</dd></dl>
</li>
</ul>
<a name="getLastSheetIndexFromExternSheetIndex(int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLastSheetIndexFromExternSheetIndex</h4>
<pre>public&nbsp;int&nbsp;getLastSheetIndexFromExternSheetIndex(int&nbsp;externSheetNumber)</pre>
<div class="block">Finds the last sheet index for a particular external sheet number,
  which may be the same as the first (except for multi-sheet references)</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>externSheetNumber</code> - The external sheet number to convert</dd>
<dt><span class="strong">Returns:</span></dt><dd>The index to the sheet found.</dd></dl>
</li>
</ul>
<a name="checkExternSheet(int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>checkExternSheet</h4>
<pre>public&nbsp;short&nbsp;checkExternSheet(int&nbsp;sheetNumber)</pre>
<div class="block">Returns the extern sheet number for specific sheet number.
 If this sheet doesn't exist in extern sheet, add it</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>sheetNumber</code> - local sheet number</dd>
<dt><span class="strong">Returns:</span></dt><dd>index to extern sheet</dd></dl>
</li>
</ul>
<a name="checkExternSheet(int, int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>checkExternSheet</h4>
<pre>public&nbsp;short&nbsp;checkExternSheet(int&nbsp;firstSheetNumber,
                     int&nbsp;lastSheetNumber)</pre>
<div class="block">Returns the extern sheet number for specific range of sheets.
 If this sheet range doesn't exist in extern sheet, add it</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>firstSheetNumber</code> - first local sheet number</dd><dd><code>lastSheetNumber</code> - last local sheet number</dd>
<dt><span class="strong">Returns:</span></dt><dd>index to extern sheet</dd></dl>
</li>
</ul>
<a name="getExternalSheetIndex(java.lang.String, java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExternalSheetIndex</h4>
<pre>public&nbsp;int&nbsp;getExternalSheetIndex(java.lang.String&nbsp;workbookName,
                        java.lang.String&nbsp;sheetName)</pre>
</li>
</ul>
<a name="getExternalSheetIndex(java.lang.String, java.lang.String, java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExternalSheetIndex</h4>
<pre>public&nbsp;int&nbsp;getExternalSheetIndex(java.lang.String&nbsp;workbookName,
                        java.lang.String&nbsp;firstSheetName,
                        java.lang.String&nbsp;lastSheetName)</pre>
</li>
</ul>
<a name="getNumNames()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNumNames</h4>
<pre>public&nbsp;int&nbsp;getNumNames()</pre>
<div class="block">gets the total number of names</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>number of names</dd></dl>
</li>
</ul>
<a name="getNameRecord(int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNameRecord</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/hssf/record/NameRecord.html" title="class in org.apache.poi.hssf.record">NameRecord</a>&nbsp;getNameRecord(int&nbsp;index)</pre>
<div class="block">gets the name record</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - name index</dd>
<dt><span class="strong">Returns:</span></dt><dd>name record</dd></dl>
</li>
</ul>
<a name="getNameCommentRecord(org.apache.poi.hssf.record.NameRecord)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNameCommentRecord</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/hssf/record/NameCommentRecord.html" title="class in org.apache.poi.hssf.record">NameCommentRecord</a>&nbsp;getNameCommentRecord(<a href="../../../../../org/apache/poi/hssf/record/NameRecord.html" title="class in org.apache.poi.hssf.record">NameRecord</a>&nbsp;nameRecord)</pre>
<div class="block">gets the name comment record</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>nameRecord</code> - name record who's comment is required.</dd>
<dt><span class="strong">Returns:</span></dt><dd>name comment record or <code>null</code> if there isn't one for the given name.</dd></dl>
</li>
</ul>
<a name="createName()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createName</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/hssf/record/NameRecord.html" title="class in org.apache.poi.hssf.record">NameRecord</a>&nbsp;createName()</pre>
<div class="block">creates new name</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>new name record</dd></dl>
</li>
</ul>
<a name="addName(org.apache.poi.hssf.record.NameRecord)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addName</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/hssf/record/NameRecord.html" title="class in org.apache.poi.hssf.record">NameRecord</a>&nbsp;addName(<a href="../../../../../org/apache/poi/hssf/record/NameRecord.html" title="class in org.apache.poi.hssf.record">NameRecord</a>&nbsp;name)</pre>
<div class="block">creates new name</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>new name record</dd></dl>
</li>
</ul>
<a name="createBuiltInName(byte, int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createBuiltInName</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/hssf/record/NameRecord.html" title="class in org.apache.poi.hssf.record">NameRecord</a>&nbsp;createBuiltInName(byte&nbsp;builtInName,
                           int&nbsp;sheetNumber)</pre>
<div class="block">Generates a NameRecord to represent a built-in region</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>a new NameRecord</dd></dl>
</li>
</ul>
<a name="removeName(int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeName</h4>
<pre>public&nbsp;void&nbsp;removeName(int&nbsp;nameIndex)</pre>
<div class="block">removes the name</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>nameIndex</code> - name index</dd></dl>
</li>
</ul>
<a name="updateNameCommentRecordCache(org.apache.poi.hssf.record.NameCommentRecord)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>updateNameCommentRecordCache</h4>
<pre>public&nbsp;void&nbsp;updateNameCommentRecordCache(<a href="../../../../../org/apache/poi/hssf/record/NameCommentRecord.html" title="class in org.apache.poi.hssf.record">NameCommentRecord</a>&nbsp;commentRecord)</pre>
<div class="block">If a <a href="../../../../../org/apache/poi/hssf/record/NameCommentRecord.html" title="class in org.apache.poi.hssf.record"><code>NameCommentRecord</code></a> is added or the name it references
  is renamed, then this will update the lookup cache for it.</div>
</li>
</ul>
<a name="getFormat(java.lang.String, boolean)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFormat</h4>
<pre>public&nbsp;short&nbsp;getFormat(java.lang.String&nbsp;format,
              boolean&nbsp;createIfNotFound)</pre>
<div class="block">Returns a format index that matches the passed in format.  It does not tie into HSSFDataFormat.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>format</code> - the format string</dd><dd><code>createIfNotFound</code> - creates a new format if format not found</dd>
<dt><span class="strong">Returns:</span></dt><dd>the format id of a format that matches or -1 if none found and createIfNotFound</dd></dl>
</li>
</ul>
<a name="getFormats()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFormats</h4>
<pre>public&nbsp;java.util.List&lt;<a href="../../../../../org/apache/poi/hssf/record/FormatRecord.html" title="class in org.apache.poi.hssf.record">FormatRecord</a>&gt;&nbsp;getFormats()</pre>
<div class="block">Returns the list of FormatRecords in the workbook.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>ArrayList of FormatRecords in the notebook</dd></dl>
</li>
</ul>
<a name="createFormat(java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createFormat</h4>
<pre>public&nbsp;int&nbsp;createFormat(java.lang.String&nbsp;formatString)</pre>
<div class="block">Creates a FormatRecord, inserts it, and returns the index code.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>formatString</code> - the format string</dd>
<dt><span class="strong">Returns:</span></dt><dd>the index code of the format record.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/poi/hssf/record/FormatRecord.html" title="class in org.apache.poi.hssf.record"><code>FormatRecord</code></a>, 
<a href="../../../../../org/apache/poi/hssf/record/Record.html" title="class in org.apache.poi.hssf.record"><code>Record</code></a></dd></dl>
</li>
</ul>
<a name="findFirstRecordBySid(short)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>findFirstRecordBySid</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/hssf/record/Record.html" title="class in org.apache.poi.hssf.record">Record</a>&nbsp;findFirstRecordBySid(short&nbsp;sid)</pre>
<div class="block">Returns the first occurance of a record matching a particular sid.</div>
</li>
</ul>
<a name="findFirstRecordLocBySid(short)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>findFirstRecordLocBySid</h4>
<pre>public&nbsp;int&nbsp;findFirstRecordLocBySid(short&nbsp;sid)</pre>
<div class="block">Returns the index of a record matching a particular sid.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>sid</code> - The sid of the record to match</dd>
<dt><span class="strong">Returns:</span></dt><dd>The index of -1 if no match made.</dd></dl>
</li>
</ul>
<a name="findNextRecordBySid(short, int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>findNextRecordBySid</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/hssf/record/Record.html" title="class in org.apache.poi.hssf.record">Record</a>&nbsp;findNextRecordBySid(short&nbsp;sid,
                         int&nbsp;pos)</pre>
<div class="block">Returns the next occurance of a record matching a particular sid.</div>
</li>
</ul>
<a name="getHyperlinks()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHyperlinks</h4>
<pre>public&nbsp;java.util.List&lt;<a href="../../../../../org/apache/poi/hssf/record/HyperlinkRecord.html" title="class in org.apache.poi.hssf.record">HyperlinkRecord</a>&gt;&nbsp;getHyperlinks()</pre>
</li>
</ul>
<a name="getRecords()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRecords</h4>
<pre>public&nbsp;java.util.List&lt;<a href="../../../../../org/apache/poi/hssf/record/Record.html" title="class in org.apache.poi.hssf.record">Record</a>&gt;&nbsp;getRecords()</pre>
</li>
</ul>
<a name="isUsing1904DateWindowing()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isUsing1904DateWindowing</h4>
<pre>public&nbsp;boolean&nbsp;isUsing1904DateWindowing()</pre>
<div class="block">Whether date windowing is based on 1/2/1904 or 1/1/1900.
 Some versions of Excel (Mac) can save workbooks using 1904 date windowing.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>true if using 1904 date windowing</dd></dl>
</li>
</ul>
<a name="getCustomPalette()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCustomPalette</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/hssf/record/PaletteRecord.html" title="class in org.apache.poi.hssf.record">PaletteRecord</a>&nbsp;getCustomPalette()</pre>
<div class="block">Returns the custom palette in use for this workbook; if a custom palette record
 does not exist, then it is created.</div>
</li>
</ul>
<a name="findDrawingGroup()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>findDrawingGroup</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/hssf/model/DrawingManager2.html" title="class in org.apache.poi.hssf.model">DrawingManager2</a>&nbsp;findDrawingGroup()</pre>
<div class="block">Finds the primary drawing group, if one already exists</div>
</li>
</ul>
<a name="createDrawingGroup()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createDrawingGroup</h4>
<pre>public&nbsp;void&nbsp;createDrawingGroup()</pre>
<div class="block">Creates a primary drawing group record.  If it already
  exists then it's modified.</div>
</li>
</ul>
<a name="getWindowOne()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWindowOne</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/hssf/record/WindowOneRecord.html" title="class in org.apache.poi.hssf.record">WindowOneRecord</a>&nbsp;getWindowOne()</pre>
</li>
</ul>
<a name="getBSERecord(int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBSERecord</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/ddf/EscherBSERecord.html" title="class in org.apache.poi.ddf">EscherBSERecord</a>&nbsp;getBSERecord(int&nbsp;pictureIndex)</pre>
</li>
</ul>
<a name="addBSERecord(org.apache.poi.ddf.EscherBSERecord)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addBSERecord</h4>
<pre>public&nbsp;int&nbsp;addBSERecord(<a href="../../../../../org/apache/poi/ddf/EscherBSERecord.html" title="class in org.apache.poi.ddf">EscherBSERecord</a>&nbsp;e)</pre>
</li>
</ul>
<a name="getDrawingManager()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDrawingManager</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/hssf/model/DrawingManager2.html" title="class in org.apache.poi.hssf.model">DrawingManager2</a>&nbsp;getDrawingManager()</pre>
</li>
</ul>
<a name="getWriteProtect()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWriteProtect</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/hssf/record/WriteProtectRecord.html" title="class in org.apache.poi.hssf.record">WriteProtectRecord</a>&nbsp;getWriteProtect()</pre>
</li>
</ul>
<a name="getWriteAccess()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWriteAccess</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/hssf/record/WriteAccessRecord.html" title="class in org.apache.poi.hssf.record">WriteAccessRecord</a>&nbsp;getWriteAccess()</pre>
</li>
</ul>
<a name="getFileSharing()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFileSharing</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/hssf/record/FileSharingRecord.html" title="class in org.apache.poi.hssf.record">FileSharingRecord</a>&nbsp;getFileSharing()</pre>
</li>
</ul>
<a name="isWriteProtected()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isWriteProtected</h4>
<pre>public&nbsp;boolean&nbsp;isWriteProtected()</pre>
<div class="block">is the workbook protected with a password (not encrypted)?</div>
</li>
</ul>
<a name="writeProtectWorkbook(java.lang.String, java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>writeProtectWorkbook</h4>
<pre>public&nbsp;void&nbsp;writeProtectWorkbook(java.lang.String&nbsp;password,
                        java.lang.String&nbsp;username)</pre>
<div class="block">protect a workbook with a password (not encypted, just sets writeprotect
 flags and the password.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>password</code> - to set</dd></dl>
</li>
</ul>
<a name="unwriteProtectWorkbook()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>unwriteProtectWorkbook</h4>
<pre>public&nbsp;void&nbsp;unwriteProtectWorkbook()</pre>
<div class="block">removes the write protect flag</div>
</li>
</ul>
<a name="resolveNameXText(int, int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>resolveNameXText</h4>
<pre>public&nbsp;java.lang.String&nbsp;resolveNameXText(int&nbsp;refIndex,
                                int&nbsp;definedNameIndex)</pre>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>refIndex</code> - Index to REF entry in EXTERNSHEET record in the Link Table</dd><dd><code>definedNameIndex</code> - zero-based to DEFINEDNAME or EXTERNALNAME record</dd>
<dt><span class="strong">Returns:</span></dt><dd>the string representation of the defined or external name</dd></dl>
</li>
</ul>
<a name="getNameXPtg(java.lang.String, int, org.apache.poi.ss.formula.udf.UDFFinder)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNameXPtg</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/ss/formula/ptg/NameXPtg.html" title="class in org.apache.poi.ss.formula.ptg">NameXPtg</a>&nbsp;getNameXPtg(java.lang.String&nbsp;name,
                   int&nbsp;sheetRefIndex,
                   <a href="../../../../../org/apache/poi/ss/formula/udf/UDFFinder.html" title="interface in org.apache.poi.ss.formula.udf">UDFFinder</a>&nbsp;udf)</pre>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the  name of an external function, typically a name of a UDF</dd><dd><code>sheetRefIndex</code> - the sheet ref index, or -1 if not known</dd><dd><code>udf</code> - locator of user-defiend functions to resolve names of VBA and Add-In functions</dd>
<dt><span class="strong">Returns:</span></dt><dd>the external name or null</dd></dl>
</li>
</ul>
<a name="getNameXPtg(java.lang.String, org.apache.poi.ss.formula.udf.UDFFinder)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNameXPtg</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/ss/formula/ptg/NameXPtg.html" title="class in org.apache.poi.ss.formula.ptg">NameXPtg</a>&nbsp;getNameXPtg(java.lang.String&nbsp;name,
                   <a href="../../../../../org/apache/poi/ss/formula/udf/UDFFinder.html" title="interface in org.apache.poi.ss.formula.udf">UDFFinder</a>&nbsp;udf)</pre>
</li>
</ul>
<a name="cloneDrawings(org.apache.poi.hssf.model.InternalSheet)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cloneDrawings</h4>
<pre>public&nbsp;void&nbsp;cloneDrawings(<a href="../../../../../org/apache/poi/hssf/model/InternalSheet.html" title="class in org.apache.poi.hssf.model">InternalSheet</a>&nbsp;sheet)</pre>
<div class="block">Check if the cloned sheet has drawings. If yes, then allocate a new drawing group ID and
 re-generate shape IDs</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>sheet</code> - the cloned sheet</dd></dl>
</li>
</ul>
<a name="cloneFilter(int, int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cloneFilter</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/hssf/record/NameRecord.html" title="class in org.apache.poi.hssf.record">NameRecord</a>&nbsp;cloneFilter(int&nbsp;filterDbNameIndex,
                     int&nbsp;newSheetIndex)</pre>
</li>
</ul>
<a name="updateNamesAfterCellShift(org.apache.poi.ss.formula.FormulaShifter)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>updateNamesAfterCellShift</h4>
<pre>public&nbsp;void&nbsp;updateNamesAfterCellShift(<a href="../../../../../org/apache/poi/ss/formula/FormulaShifter.html" title="class in org.apache.poi.ss.formula">FormulaShifter</a>&nbsp;shifter)</pre>
<div class="block">Updates named ranges due to moving of cells</div>
</li>
</ul>
<a name="getRecalcId()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRecalcId</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/hssf/record/RecalcIdRecord.html" title="class in org.apache.poi.hssf.record">RecalcIdRecord</a>&nbsp;getRecalcId()</pre>
<div class="block">Get or create RecalcIdRecord</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#setForceFormulaRecalculation(boolean)"><code>HSSFWorkbook.setForceFormulaRecalculation(boolean)</code></a></dd></dl>
</li>
</ul>
<a name="changeExternalReference(java.lang.String, java.lang.String)">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>changeExternalReference</h4>
<pre>public&nbsp;boolean&nbsp;changeExternalReference(java.lang.String&nbsp;oldUrl,
                              java.lang.String&nbsp;newUrl)</pre>
<div class="block">Changes an external referenced file to another file.
 A formular in Excel which refers a cell in another file is saved in two parts: 
 The referenced file is stored in an reference table. the row/cell information is saved separate.
 This method invokation will only change the reference in the lookup-table itself.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>oldUrl</code> - The old URL to search for and which is to be replaced</dd><dd><code>newUrl</code> - The URL replacement</dd>
<dt><span class="strong">Returns:</span></dt><dd>true if the oldUrl was found and replaced with newUrl. Otherwise false</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!--   -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/InternalWorkbook.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/poi/hssf/model/InternalSheet.UnsupportedBOFType.html" title="class in org.apache.poi.hssf.model"><span class="strong">PREV CLASS</span></a></li>
<li><a href="../../../../../org/apache/poi/hssf/model/LineShape.html" title="class in org.apache.poi.hssf.model"><span class="strong">NEXT CLASS</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/poi/hssf/model/InternalWorkbook.html" target="_top">FRAMES</a></li>
<li><a href="InternalWorkbook.html" target="_top">NO FRAMES</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_bottom");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>SUMMARY:&nbsp;</li>
<li>NESTED&nbsp;|&nbsp;</li>
<li><a href="#field_summary">FIELD</a>&nbsp;|&nbsp;</li>
<li>CONSTR&nbsp;|&nbsp;</li>
<li><a href="#method_summary">METHOD</a></li>
</ul>
<ul class="subNavList">
<li>DETAIL:&nbsp;</li>
<li><a href="#field_detail">FIELD</a>&nbsp;|&nbsp;</li>
<li>CONSTR&nbsp;|&nbsp;</li>
<li><a href="#method_detail">METHOD</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!--   -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>
                <i>Copyright 2014 The Apache Software Foundation or
        its licensors, as applicable.</i>
            </small></p>
</body>
</html>
